Documentation

Developers

Featured Endpoints

Checkouts

Discounts

License Keys

Oauth2

Organizations

Products

Users

Issue Funding Endpoints

External Organizations

Repositories

Other Endpoints

Advertisements

Articles

Benefits

Checkout-Links

Checkouts

Custom-Fields

Files

Metrics

Oauth2

Orders

Subscriptions

Users

users

Get Benefit

get
/v1/users/benefits/{id}
Get a granted benefit by ID.
curl -X GET \
    'https://api.polar.sh/v1/users/benefits/00000000-0000-0000-0000-000000000000' \
    -H "Accept: application/json" \
    -H "Authorization: Bearer <token>" \
    
Responses
{
  "created_at": "2024-12-12T00:00:00.000Z",
  "modified_at": "2024-12-12T00:00:00.000Z",
  "id": "00000000-0000-0000-0000-000000000000",
  "type": "articles",
  "description": "string",
  "selectable": false,
  "deletable": false,
  "organization_id": "00000000-0000-0000-0000-000000000000",
  "grants": [
    {
      "created_at": "2024-12-12T00:00:00.000Z",
      "modified_at": "2024-12-12T00:00:00.000Z",
      "id": "00000000-0000-0000-0000-000000000000",
      "granted_at": "2024-12-12T00:00:00.000Z",
      "is_granted": false,
      "revoked_at": "2024-12-12T00:00:00.000Z",
      "is_revoked": false,
      "subscription_id": "00000000-0000-0000-0000-000000000000",
      "order_id": "00000000-0000-0000-0000-000000000000",
      "user_id": "00000000-0000-0000-0000-000000000000",
      "benefit_id": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "organization": {
    "created_at": "2024-12-12T00:00:00.000Z",
    "modified_at": "2024-12-12T00:00:00.000Z",
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "slug": "string",
    "avatar_url": "string",
    "bio": "string",
    "company": "string",
    "blog": "string",
    "location": "string",
    "email": "string",
    "twitter_username": "string",
    "pledge_minimum_amount": 0,
    "pledge_badge_show_amount": false,
    "default_upfront_split_to_contributors": 0,
    "profile_settings": {
      "enabled": false,
      "description": "string",
      "featured_projects": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "featured_organizations": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "links": [
        "string"
      ],
      "subscribe": {
        "promote": false,
        "show_count": false,
        "count_free": false
      },
      "accent_color": "string"
    },
    "feature_settings": {
      "articles_enabled": false,
      "issue_funding_enabled": false
    }
  },
  "properties": {
    "paid_articles": false
  }
}